<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilmailbox: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilmailbox
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xilmailbox.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#enumval-members">Enumerator</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mailbox___agent.html">XMailbox_Agent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure used to refer Xilmailbox agents.  <a href="struct_x_mailbox___agent.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox_tag.html">XMboxTag</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure used to refer XilMailbox.  <a href="struct_x_mbox_tag.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gad27cc17b25bb93134368d5eb21126eae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(x)&#160;&#160;&#160;(1 &lt;&lt; (x))</td></tr>
<tr class="memdesc:gad27cc17b25bb93134368d5eb21126eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit position.  <a href="#gad27cc17b25bb93134368d5eb21126eae">More...</a><br/></td></tr>
<tr class="separator:gad27cc17b25bb93134368d5eb21126eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf22e2c7d554cc41b64ba743959394334"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gaf22e2c7d554cc41b64ba743959394334">XIPI_DONE_TIMEOUT_VAL</a>&#160;&#160;&#160;2000000</td></tr>
<tr class="memdesc:gaf22e2c7d554cc41b64ba743959394334"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout for IPI.  <a href="#gaf22e2c7d554cc41b64ba743959394334">More...</a><br/></td></tr>
<tr class="separator:gaf22e2c7d554cc41b64ba743959394334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga325538ceb2db30df5882c8e45353836a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga325538ceb2db30df5882c8e45353836a">XIPI_IPI_DONE_BIT_SLEEP_IN_US</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga325538ceb2db30df5882c8e45353836a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep for 1Us.  <a href="#ga325538ceb2db30df5882c8e45353836a">More...</a><br/></td></tr>
<tr class="separator:ga325538ceb2db30df5882c8e45353836a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadf643d08bd8cbcfde6234a6bdaae9e88"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gadf643d08bd8cbcfde6234a6bdaae9e88">XMAILBOX_IPI0</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(0)</td></tr>
<tr class="memdesc:gadf643d08bd8cbcfde6234a6bdaae9e88"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI0 channel.  <a href="#gadf643d08bd8cbcfde6234a6bdaae9e88">More...</a><br/></td></tr>
<tr class="separator:gadf643d08bd8cbcfde6234a6bdaae9e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dfcd88e42de7df2bb14c4e53cb0baf0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga9dfcd88e42de7df2bb14c4e53cb0baf0">XMAILBOX_IPI1</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(8)</td></tr>
<tr class="memdesc:ga9dfcd88e42de7df2bb14c4e53cb0baf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI1 channel.  <a href="#ga9dfcd88e42de7df2bb14c4e53cb0baf0">More...</a><br/></td></tr>
<tr class="separator:ga9dfcd88e42de7df2bb14c4e53cb0baf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27bb5399c2b52ff698f50939e852ef96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga27bb5399c2b52ff698f50939e852ef96">XMAILBOX_IPI2</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(9)</td></tr>
<tr class="memdesc:ga27bb5399c2b52ff698f50939e852ef96"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI2 channel.  <a href="#ga27bb5399c2b52ff698f50939e852ef96">More...</a><br/></td></tr>
<tr class="separator:ga27bb5399c2b52ff698f50939e852ef96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae693c768701e9ebac21c32682c99a6be"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gae693c768701e9ebac21c32682c99a6be">XMAILBOX_IPI3</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(16)</td></tr>
<tr class="memdesc:gae693c768701e9ebac21c32682c99a6be"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI3 channel.  <a href="#gae693c768701e9ebac21c32682c99a6be">More...</a><br/></td></tr>
<tr class="separator:gae693c768701e9ebac21c32682c99a6be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc4bcf7cc2a5141b29870f870baf539e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gacc4bcf7cc2a5141b29870f870baf539e">XMAILBOX_IPI4</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(17)</td></tr>
<tr class="memdesc:gacc4bcf7cc2a5141b29870f870baf539e"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI4 channel.  <a href="#gacc4bcf7cc2a5141b29870f870baf539e">More...</a><br/></td></tr>
<tr class="separator:gacc4bcf7cc2a5141b29870f870baf539e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18b88012ba5175a2fda995623f674deb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga18b88012ba5175a2fda995623f674deb">XMAILBOX_IPI5</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(18)</td></tr>
<tr class="memdesc:ga18b88012ba5175a2fda995623f674deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI5 channel.  <a href="#ga18b88012ba5175a2fda995623f674deb">More...</a><br/></td></tr>
<tr class="separator:ga18b88012ba5175a2fda995623f674deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15fe91a5f25cb5c519934a3433cda5ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga15fe91a5f25cb5c519934a3433cda5ac">XMAILBOX_IPI6</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(19)</td></tr>
<tr class="memdesc:ga15fe91a5f25cb5c519934a3433cda5ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI6 channel.  <a href="#ga15fe91a5f25cb5c519934a3433cda5ac">More...</a><br/></td></tr>
<tr class="separator:ga15fe91a5f25cb5c519934a3433cda5ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44541be2c1254fe744f234ebc7f862de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga44541be2c1254fe744f234ebc7f862de">XMAILBOX_IPI7</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(24)</td></tr>
<tr class="memdesc:ga44541be2c1254fe744f234ebc7f862de"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI7 channel.  <a href="#ga44541be2c1254fe744f234ebc7f862de">More...</a><br/></td></tr>
<tr class="separator:ga44541be2c1254fe744f234ebc7f862de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae8d87074363b612d23bb0fdcd7227c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gaae8d87074363b612d23bb0fdcd7227c7">XMAILBOX_IPI8</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(25)</td></tr>
<tr class="memdesc:gaae8d87074363b612d23bb0fdcd7227c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI8 channel.  <a href="#gaae8d87074363b612d23bb0fdcd7227c7">More...</a><br/></td></tr>
<tr class="separator:gaae8d87074363b612d23bb0fdcd7227c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga614efa3482faad5c76efb8e9d8bcaba1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga614efa3482faad5c76efb8e9d8bcaba1">XMAILBOX_IPI9</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(26)</td></tr>
<tr class="memdesc:ga614efa3482faad5c76efb8e9d8bcaba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI9 channel.  <a href="#ga614efa3482faad5c76efb8e9d8bcaba1">More...</a><br/></td></tr>
<tr class="separator:ga614efa3482faad5c76efb8e9d8bcaba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab888e665d43986e50eaba5abcdcda68a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gab888e665d43986e50eaba5abcdcda68a">XMAILBOX_IPI10</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(27)</td></tr>
<tr class="memdesc:gab888e665d43986e50eaba5abcdcda68a"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPI10 channel.  <a href="#gab888e665d43986e50eaba5abcdcda68a">More...</a><br/></td></tr>
<tr class="separator:gab888e665d43986e50eaba5abcdcda68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf83db6a62871c736b4f8f485d56caed8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gaf83db6a62871c736b4f8f485d56caed8">XMAILBOX_MAX_CHANNELS</a>&#160;&#160;&#160;11U</td></tr>
<tr class="memdesc:gaf83db6a62871c736b4f8f485d56caed8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum channel.  <a href="#gaf83db6a62871c736b4f8f485d56caed8">More...</a><br/></td></tr>
<tr class="separator:gaf83db6a62871c736b4f8f485d56caed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad14b42daa39e07711ec871f737bdb41b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gad14b42daa39e07711ec871f737bdb41b">XMAILBOX_INTR_ID</a>&#160;&#160;&#160;22U</td></tr>
<tr class="memdesc:gad14b42daa39e07711ec871f737bdb41b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt id.  <a href="#gad14b42daa39e07711ec871f737bdb41b">More...</a><br/></td></tr>
<tr class="separator:gad14b42daa39e07711ec871f737bdb41b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga90293f74a32c52eb71ecf11d8c34bc3d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga90293f74a32c52eb71ecf11d8c34bc3d">IPI_BASEADDRESS</a>&#160;&#160;&#160;0xFF380000U</td></tr>
<tr class="memdesc:ga90293f74a32c52eb71ecf11d8c34bc3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base Address.  <a href="#ga90293f74a32c52eb71ecf11d8c34bc3d">More...</a><br/></td></tr>
<tr class="separator:ga90293f74a32c52eb71ecf11d8c34bc3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10837217c3d1614d878ab47ff497e30c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga10837217c3d1614d878ab47ff497e30c">IPI_ADDRDECODE_ERROR</a>&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(0)</td></tr>
<tr class="memdesc:ga10837217c3d1614d878ab47ff497e30c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address decode error.  <a href="#ga10837217c3d1614d878ab47ff497e30c">More...</a><br/></td></tr>
<tr class="separator:ga10837217c3d1614d878ab47ff497e30c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab916c58f41e76689faa0d2ca46df0427"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gab916c58f41e76689faa0d2ca46df0427">XILMBOX_MSG_TYPE_REQ</a>&#160;&#160;&#160;(0x00000001U)</td></tr>
<tr class="memdesc:gab916c58f41e76689faa0d2ca46df0427"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message type buffer.  <a href="#gab916c58f41e76689faa0d2ca46df0427">More...</a><br/></td></tr>
<tr class="separator:gab916c58f41e76689faa0d2ca46df0427"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga499095c8a6320e4eff3871d739cfafd2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga499095c8a6320e4eff3871d739cfafd2">XILMBOX_MSG_TYPE_RESP</a>&#160;&#160;&#160;(0x00000002U)</td></tr>
<tr class="memdesc:ga499095c8a6320e4eff3871d739cfafd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Response type buffer.  <a href="#ga499095c8a6320e4eff3871d739cfafd2">More...</a><br/></td></tr>
<tr class="separator:ga499095c8a6320e4eff3871d739cfafd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02889c9c255257274405440f2e0398f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga02889c9c255257274405440f2e0398f0">XMAILBOX_MAX_MSG_LEN</a>&#160;&#160;&#160;XIPIPSU_MAX_MSG_LEN</td></tr>
<tr class="memdesc:ga02889c9c255257274405440f2e0398f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of Messages (each 4-bytes long)  <a href="#ga02889c9c255257274405440f2e0398f0">More...</a><br/></td></tr>
<tr class="separator:ga02889c9c255257274405440f2e0398f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0661fcb809edc8a04919686b2c24c2de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga0661fcb809edc8a04919686b2c24c2de">XMAILBOX_PAYLOAD_LEN_1U</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga0661fcb809edc8a04919686b2c24c2de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload lengths.  <a href="#ga0661fcb809edc8a04919686b2c24c2de">More...</a><br/></td></tr>
<tr class="separator:ga0661fcb809edc8a04919686b2c24c2de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ac9914b3773f66786c14b83ed4ec1d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga3ac9914b3773f66786c14b83ed4ec1d6">XMAILBOX_PAYLOAD_LEN_2U</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:ga3ac9914b3773f66786c14b83ed4ec1d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 2byte.  <a href="#ga3ac9914b3773f66786c14b83ed4ec1d6">More...</a><br/></td></tr>
<tr class="separator:ga3ac9914b3773f66786c14b83ed4ec1d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga433526fce7d55430d5dd884c55236595"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga433526fce7d55430d5dd884c55236595">XMAILBOX_PAYLOAD_LEN_3U</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:ga433526fce7d55430d5dd884c55236595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 3byte.  <a href="#ga433526fce7d55430d5dd884c55236595">More...</a><br/></td></tr>
<tr class="separator:ga433526fce7d55430d5dd884c55236595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8bd056c2d1d38cd4f0c766b71276b64b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga8bd056c2d1d38cd4f0c766b71276b64b">XMAILBOX_PAYLOAD_LEN_4U</a>&#160;&#160;&#160;(4U)</td></tr>
<tr class="memdesc:ga8bd056c2d1d38cd4f0c766b71276b64b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 4byte.  <a href="#ga8bd056c2d1d38cd4f0c766b71276b64b">More...</a><br/></td></tr>
<tr class="separator:ga8bd056c2d1d38cd4f0c766b71276b64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad6fec3e5646c0de92448b1ac51a3d8fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gad6fec3e5646c0de92448b1ac51a3d8fb">XMAILBOX_PAYLOAD_LEN_5U</a>&#160;&#160;&#160;(5U)</td></tr>
<tr class="memdesc:gad6fec3e5646c0de92448b1ac51a3d8fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 5byte.  <a href="#gad6fec3e5646c0de92448b1ac51a3d8fb">More...</a><br/></td></tr>
<tr class="separator:gad6fec3e5646c0de92448b1ac51a3d8fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e6886e99fe8eed940eb84c67bdf7717"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga5e6886e99fe8eed940eb84c67bdf7717">XMAILBOX_PAYLOAD_LEN_6U</a>&#160;&#160;&#160;(6U)</td></tr>
<tr class="memdesc:ga5e6886e99fe8eed940eb84c67bdf7717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 6byte.  <a href="#ga5e6886e99fe8eed940eb84c67bdf7717">More...</a><br/></td></tr>
<tr class="separator:ga5e6886e99fe8eed940eb84c67bdf7717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f56628c135a38c50e52c4346895ca81"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga0f56628c135a38c50e52c4346895ca81">XMAILBOX_PAYLOAD_LEN_7U</a>&#160;&#160;&#160;(7U)</td></tr>
<tr class="memdesc:ga0f56628c135a38c50e52c4346895ca81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload length of size 7byte.  <a href="#ga0f56628c135a38c50e52c4346895ca81">More...</a><br/></td></tr>
<tr class="separator:ga0f56628c135a38c50e52c4346895ca81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8c6dc8e77b4ca1440fff62efadefa502"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga8c6dc8e77b4ca1440fff62efadefa502">XMailbox_RecvHandler</a> )(void *CallBackRefPtr)</td></tr>
<tr class="memdesc:ga8c6dc8e77b4ca1440fff62efadefa502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive handler.  <a href="#ga8c6dc8e77b4ca1440fff62efadefa502">More...</a><br/></td></tr>
<tr class="separator:ga8c6dc8e77b4ca1440fff62efadefa502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2dd8ee990e164df828207776499cf9bc"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga2dd8ee990e164df828207776499cf9bc">XMailbox_ErrorHandler</a> )(void *CallBackRefPtr, u32 ErrorMask)</td></tr>
<tr class="memdesc:ga2dd8ee990e164df828207776499cf9bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error handler.  <a href="#ga2dd8ee990e164df828207776499cf9bc">More...</a><br/></td></tr>
<tr class="separator:ga2dd8ee990e164df828207776499cf9bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade56a2dd883b18d7ae9a891483c90b40"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a></td></tr>
<tr class="memdesc:gade56a2dd883b18d7ae9a891483c90b40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure used to refer XilMailbox.  <a href="#gade56a2dd883b18d7ae9a891483c90b40">More...</a><br/></td></tr>
<tr class="separator:gade56a2dd883b18d7ae9a891483c90b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaa7c3c20ddbc2f808a7520d82d1f1778a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gaa7c3c20ddbc2f808a7520d82d1f1778a">XMailbox_IpiSharedMemState</a> { <a class="el" href="group__xilmailbox.html#ggaa7c3c20ddbc2f808a7520d82d1f1778aac0cb85045fed16a25937a7e3d3db62b6">XMAILBOX_SHARED_MEM_UNINITIALIZED</a> = 0,
<a class="el" href="group__xilmailbox.html#ggaa7c3c20ddbc2f808a7520d82d1f1778aaadb64220277cf0ee43d0dbd58d09e895">XMAILBOX_SHARED_MEM_INITIALIZED</a>
 }</td></tr>
<tr class="memdesc:gaa7c3c20ddbc2f808a7520d82d1f1778a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains XMAILBOX shared memory state.  <a href="group__xilmailbox.html#gaa7c3c20ddbc2f808a7520d82d1f1778a">More...</a><br/></td></tr>
<tr class="separator:gaa7c3c20ddbc2f808a7520d82d1f1778a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga143f24a7eb4d52ae8289dd2a76104b5e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga143f24a7eb4d52ae8289dd2a76104b5e">XMailbox_Handler</a> { <a class="el" href="group__xilmailbox.html#gga143f24a7eb4d52ae8289dd2a76104b5ea875addbc928be95ae410ab219c1cfcd3">XMAILBOX_RECV_HANDLER</a>,
<a class="el" href="group__xilmailbox.html#gga143f24a7eb4d52ae8289dd2a76104b5ea4bb156987a17b1507eff3df3e601c716">XMAILBOX_ERROR_HANDLER</a>
 }</td></tr>
<tr class="memdesc:ga143f24a7eb4d52ae8289dd2a76104b5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains XMAILBOX Handler Types.  <a href="group__xilmailbox.html#ga143f24a7eb4d52ae8289dd2a76104b5e">More...</a><br/></td></tr>
<tr class="separator:ga143f24a7eb4d52ae8289dd2a76104b5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga2cd630709ee77e8c082f923c2a72ec67"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u8 DeviceId)</td></tr>
<tr class="memdesc:ga2cd630709ee77e8c082f923c2a72ec67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the ZynqMP Mailbox Instance.  <a href="#ga2cd630709ee77e8c082f923c2a72ec67">More...</a><br/></td></tr>
<tr class="separator:ga2cd630709ee77e8c082f923c2a72ec67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe03d42ebcf3d3e93c2fb709de6e9142"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u8 Is_Blocking)</td></tr>
<tr class="memdesc:gafe03d42ebcf3d3e93c2fb709de6e9142"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function triggers an IPI to a destnation CPU.  <a href="#gafe03d42ebcf3d3e93c2fb709de6e9142">More...</a><br/></td></tr>
<tr class="separator:gafe03d42ebcf3d3e93c2fb709de6e9142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6a5843a165afbc782fb45ab48e8b77d"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, void *MsgBufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking)</td></tr>
<tr class="memdesc:gae6a5843a165afbc782fb45ab48e8b77d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends an IPI message to a destnation CPU.  <a href="#gae6a5843a165afbc782fb45ab48e8b77d">More...</a><br/></td></tr>
<tr class="separator:gae6a5843a165afbc782fb45ab48e8b77d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56a6cdab3dba08f469f27b341aa3c178"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga56a6cdab3dba08f469f27b341aa3c178">XIpiPs_RecvData</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, void *MsgBufferPtr, u32 MsgLen, u8 BufferType)</td></tr>
<tr class="memdesc:ga56a6cdab3dba08f469f27b341aa3c178"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads an IPI message.  <a href="#ga56a6cdab3dba08f469f27b341aa3c178">More...</a><br/></td></tr>
<tr class="separator:ga56a6cdab3dba08f469f27b341aa3c178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f8f4f223ac7cab8c35b259803256e50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler</a> (void *XMailboxPtr)</td></tr>
<tr class="memdesc:ga4f8f4f223ac7cab8c35b259803256e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function implements the interrupt handler.  <a href="#ga4f8f4f223ac7cab8c35b259803256e50">More...</a><br/></td></tr>
<tr class="separator:ga4f8f4f223ac7cab8c35b259803256e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f7e6c0a58db61bda83ef28be9acba71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga3f7e6c0a58db61bda83ef28be9acba71">XIpiPs_ErrorIntrHandler</a> (void *XMailboxPtr)</td></tr>
<tr class="memdesc:ga3f7e6c0a58db61bda83ef28be9acba71"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function implements the interrupt handler for errors.  <a href="#ga3f7e6c0a58db61bda83ef28be9acba71">More...</a><br/></td></tr>
<tr class="separator:ga3f7e6c0a58db61bda83ef28be9acba71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb81c93bcb13ef48d004b89eb27ecc6c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gadb81c93bcb13ef48d004b89eb27ecc6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for an acknowledgement using Observation Register.  <a href="#gadb81c93bcb13ef48d004b89eb27ecc6c">More...</a><br/></td></tr>
<tr class="separator:gadb81c93bcb13ef48d004b89eb27ecc6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c82843dbbfc6bf3010fa1966de899e4"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq</a> (XScuGic *IntcInstancePtr, <a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u32 IpiIntrId)</td></tr>
<tr class="memdesc:ga0c82843dbbfc6bf3010fa1966de899e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers an irq.  <a href="#ga0c82843dbbfc6bf3010fa1966de899e4">More...</a><br/></td></tr>
<tr class="separator:ga0c82843dbbfc6bf3010fa1966de899e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga626145fbf006cb062b91ef47889a49ed"><td class="memItemLeft" align="right" valign="top">XIpiPsu&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a></td></tr>
<tr class="memdesc:ga626145fbf006cb062b91ef47889a49ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ipi instance.  <a href="#ga626145fbf006cb062b91ef47889a49ed">More...</a><br/></td></tr>
<tr class="separator:ga626145fbf006cb062b91ef47889a49ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5697f39a913b178ec64c6cff4575bb0e"><td class="memItemLeft" align="right" valign="top">XScuGic&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga5697f39a913b178ec64c6cff4575bb0e">XMailbox_Agent::GicInst</a></td></tr>
<tr class="memdesc:ga5697f39a913b178ec64c6cff4575bb0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt instance.  <a href="#ga5697f39a913b178ec64c6cff4575bb0e">More...</a><br/></td></tr>
<tr class="separator:ga5697f39a913b178ec64c6cff4575bb0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a6fb8ef4ca25e40d3640a37ae80704c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga4a6fb8ef4ca25e40d3640a37ae80704c">XMailbox_Agent::SourceId</a></td></tr>
<tr class="memdesc:ga4a6fb8ef4ca25e40d3640a37ae80704c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source id.  <a href="#ga4a6fb8ef4ca25e40d3640a37ae80704c">More...</a><br/></td></tr>
<tr class="separator:ga4a6fb8ef4ca25e40d3640a37ae80704c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5de32cff7d1fe5e482d0e3d75b528e6f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a></td></tr>
<tr class="memdesc:ga5de32cff7d1fe5e482d0e3d75b528e6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remote id.  <a href="#ga5de32cff7d1fe5e482d0e3d75b528e6f">More...</a><br/></td></tr>
<tr class="separator:ga5de32cff7d1fe5e482d0e3d75b528e6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a9a0371a0256d6ba537a3db7698fb08"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga4a9a0371a0256d6ba537a3db7698fb08">XMailbox_IpiSharedMem::Address</a></td></tr>
<tr class="memdesc:ga4a9a0371a0256d6ba537a3db7698fb08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address of the shared memory location.  <a href="#ga4a9a0371a0256d6ba537a3db7698fb08">More...</a><br/></td></tr>
<tr class="separator:ga4a9a0371a0256d6ba537a3db7698fb08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae27eb1bb697a00c85f295ef36cd55632"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gae27eb1bb697a00c85f295ef36cd55632">XMailbox_IpiSharedMem::Size</a></td></tr>
<tr class="memdesc:gae27eb1bb697a00c85f295ef36cd55632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the shared memory location.  <a href="#gae27eb1bb697a00c85f295ef36cd55632">More...</a><br/></td></tr>
<tr class="separator:gae27eb1bb697a00c85f295ef36cd55632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73b6a118babef017d2679b59a0410a89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__xilmailbox.html#gaa7c3c20ddbc2f808a7520d82d1f1778a">XMailbox_IpiSharedMemState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga73b6a118babef017d2679b59a0410a89">XMailbox_IpiSharedMem::SharedMemState</a></td></tr>
<tr class="memdesc:ga73b6a118babef017d2679b59a0410a89"><td class="mdescLeft">&#160;</td><td class="mdescRight">State of shared memory.  <a href="#ga73b6a118babef017d2679b59a0410a89">More...</a><br/></td></tr>
<tr class="separator:ga73b6a118babef017d2679b59a0410a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac988653f4102330b66dffc80008e5947"><td class="memItemLeft" align="right" valign="top">u32(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gac988653f4102330b66dffc80008e5947">XMboxTag::XMbox_IPI_Send</a> )(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, u8 Is_Blocking)</td></tr>
<tr class="memdesc:gac988653f4102330b66dffc80008e5947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers an IPI to a destination CPU.  <a href="#gac988653f4102330b66dffc80008e5947">More...</a><br/></td></tr>
<tr class="separator:gac988653f4102330b66dffc80008e5947"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad2979174f02c95bba9e1a9a82da86eb6"><td class="memItemLeft" align="right" valign="top">u32(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gad2979174f02c95bba9e1a9a82da86eb6">XMboxTag::XMbox_IPI_SendData</a> )(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking)</td></tr>
<tr class="memdesc:gad2979174f02c95bba9e1a9a82da86eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IPI message to a destination CPU.  <a href="#gad2979174f02c95bba9e1a9a82da86eb6">More...</a><br/></td></tr>
<tr class="separator:gad2979174f02c95bba9e1a9a82da86eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfc620b1b6bee8a53e35bd937d01ef9a"><td class="memItemLeft" align="right" valign="top">u32(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gacfc620b1b6bee8a53e35bd937d01ef9a">XMboxTag::XMbox_IPI_Recv</a> )(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType)</td></tr>
<tr class="memdesc:gacfc620b1b6bee8a53e35bd937d01ef9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an IPI message.  <a href="#gacfc620b1b6bee8a53e35bd937d01ef9a">More...</a><br/></td></tr>
<tr class="separator:gacfc620b1b6bee8a53e35bd937d01ef9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19abe88291a590c4043f0c14f3abbea6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__xilmailbox.html#ga8c6dc8e77b4ca1440fff62efadefa502">XMailbox_RecvHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga19abe88291a590c4043f0c14f3abbea6">XMboxTag::RecvHandler</a></td></tr>
<tr class="memdesc:ga19abe88291a590c4043f0c14f3abbea6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive handler.  <a href="#ga19abe88291a590c4043f0c14f3abbea6">More...</a><br/></td></tr>
<tr class="separator:ga19abe88291a590c4043f0c14f3abbea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94ad8c15322f8aa87898da64c12d680c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__xilmailbox.html#ga2dd8ee990e164df828207776499cf9bc">XMailbox_ErrorHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga94ad8c15322f8aa87898da64c12d680c">XMboxTag::ErrorHandler</a></td></tr>
<tr class="memdesc:ga94ad8c15322f8aa87898da64c12d680c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for rx IPI event.  <a href="#ga94ad8c15322f8aa87898da64c12d680c">More...</a><br/></td></tr>
<tr class="separator:ga94ad8c15322f8aa87898da64c12d680c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28ee974b8253aed6cd98a41d017e92b5"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga28ee974b8253aed6cd98a41d017e92b5">XMboxTag::ErrorRefPtr</a></td></tr>
<tr class="memdesc:ga28ee974b8253aed6cd98a41d017e92b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">To be passed to the error interrupt callback.  <a href="#ga28ee974b8253aed6cd98a41d017e92b5">More...</a><br/></td></tr>
<tr class="separator:ga28ee974b8253aed6cd98a41d017e92b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd81ebeec1ff8eb6bbd4b62922688353"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gacd81ebeec1ff8eb6bbd4b62922688353">XMboxTag::RecvRefPtr</a></td></tr>
<tr class="memdesc:gacd81ebeec1ff8eb6bbd4b62922688353"><td class="mdescLeft">&#160;</td><td class="mdescRight">To be passed to the receive interrupt callback.  <a href="#gacd81ebeec1ff8eb6bbd4b62922688353">More...</a><br/></td></tr>
<tr class="separator:gacd81ebeec1ff8eb6bbd4b62922688353"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74c5b640e4fca80f8de65a5c516f6674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mailbox___agent.html">XMailbox_Agent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a></td></tr>
<tr class="memdesc:ga74c5b640e4fca80f8de65a5c516f6674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Agent to store IPI channel information.  <a href="#ga74c5b640e4fca80f8de65a5c516f6674">More...</a><br/></td></tr>
<tr class="separator:ga74c5b640e4fca80f8de65a5c516f6674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7807e734780a6c78cf0129b065d8a0b3"><td class="memItemLeft" align="right" valign="top">XMailbox_IpiSharedMem&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga7807e734780a6c78cf0129b065d8a0b3">XMboxTag::SharedMem</a></td></tr>
<tr class="memdesc:ga7807e734780a6c78cf0129b065d8a0b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">shared memory segment  <a href="#ga7807e734780a6c78cf0129b065d8a0b3">More...</a><br/></td></tr>
<tr class="separator:ga7807e734780a6c78cf0129b065d8a0b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga212445a83a040999add733502bcc34e9"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u8 DeviceId)</td></tr>
<tr class="memdesc:ga212445a83a040999add733502bcc34e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the XMailbox Instance.  <a href="#ga212445a83a040999add733502bcc34e9">More...</a><br/></td></tr>
<tr class="separator:ga212445a83a040999add733502bcc34e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b1215935d7ba605846e3a13f015e956"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga3b1215935d7ba605846e3a13f015e956">XMailbox_Send</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u32 RemoteId, u8 Is_Blocking)</td></tr>
<tr class="memdesc:ga3b1215935d7ba605846e3a13f015e956"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function triggers an IPI to a destination CPU.  <a href="#ga3b1215935d7ba605846e3a13f015e956">More...</a><br/></td></tr>
<tr class="separator:ga3b1215935d7ba605846e3a13f015e956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c8296024494f03b6e33a54fe80ba3da"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u32 RemoteId, void *BufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking)</td></tr>
<tr class="memdesc:ga4c8296024494f03b6e33a54fe80ba3da"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends an IPI message to a destination CPU.  <a href="#ga4c8296024494f03b6e33a54fe80ba3da">More...</a><br/></td></tr>
<tr class="separator:ga4c8296024494f03b6e33a54fe80ba3da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e5da60f7c2fc80ec54209fc4031c03b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u32 SourceId, void *BufferPtr, u32 MsgLen, u8 BufferType)</td></tr>
<tr class="memdesc:ga1e5da60f7c2fc80ec54209fc4031c03b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads an IPI message.  <a href="#ga1e5da60f7c2fc80ec54209fc4031c03b">More...</a><br/></td></tr>
<tr class="separator:ga1e5da60f7c2fc80ec54209fc4031c03b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafbc26a4d8f0d4cff937f88b125defe01"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gafbc26a4d8f0d4cff937f88b125defe01">XMailbox_SetCallBack</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, <a class="el" href="group__xilmailbox.html#ga143f24a7eb4d52ae8289dd2a76104b5e">XMailbox_Handler</a> HandlerType, void *CallBackFuncPtr, void *CallBackRefPtr)</td></tr>
<tr class="memdesc:gafbc26a4d8f0d4cff937f88b125defe01"><td class="mdescLeft">&#160;</td><td class="mdescRight">This routine installs an asynchronous callback function for the given HandlerType.  <a href="#gafbc26a4d8f0d4cff937f88b125defe01">More...</a><br/></td></tr>
<tr class="separator:gafbc26a4d8f0d4cff937f88b125defe01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a04406fa4d00d2acad6a32ff7a4230b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga5a04406fa4d00d2acad6a32ff7a4230b">XMailbox_SetSharedMem</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u64 Address, u32 Size)</td></tr>
<tr class="memdesc:ga5a04406fa4d00d2acad6a32ff7a4230b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the shared memory location for IPI usage.  <a href="#ga5a04406fa4d00d2acad6a32ff7a4230b">More...</a><br/></td></tr>
<tr class="separator:ga5a04406fa4d00d2acad6a32ff7a4230b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c4631ec46d933f1fff9ce944c3b82d6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#ga4c4631ec46d933f1fff9ce944c3b82d6">XMailbox_GetSharedMem</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr, u64 **Address)</td></tr>
<tr class="memdesc:ga4c4631ec46d933f1fff9ce944c3b82d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the shared memory location for IPI usage.  <a href="#ga4c4631ec46d933f1fff9ce944c3b82d6">More...</a><br/></td></tr>
<tr class="separator:ga4c4631ec46d933f1fff9ce944c3b82d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae18bdfda3723a66063211be38ad0a541"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilmailbox.html#gae18bdfda3723a66063211be38ad0a541">XMailbox_ReleaseSharedMem</a> (<a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *InstancePtr)</td></tr>
<tr class="memdesc:gae18bdfda3723a66063211be38ad0a541"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function releases the shared memory.  <a href="#gae18bdfda3723a66063211be38ad0a541">More...</a><br/></td></tr>
<tr class="separator:gae18bdfda3723a66063211be38ad0a541"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad27cc17b25bb93134368d5eb21126eae"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define BIT</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">x</td><td>)</td>
          <td>&#160;&#160;&#160;(1 &lt;&lt; (x))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Bit position. </p>

</div>
</div>
<a class="anchor" id="ga10837217c3d1614d878ab47ff497e30c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IPI_ADDRDECODE_ERROR&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(0)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address decode error. </p>

</div>
</div>
<a class="anchor" id="ga90293f74a32c52eb71ecf11d8c34bc3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IPI_BASEADDRESS&#160;&#160;&#160;0xFF380000U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base Address. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga3f7e6c0a58db61bda83ef28be9acba71">XIpiPs_ErrorIntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gab916c58f41e76689faa0d2ca46df0427"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XILMBOX_MSG_TYPE_REQ&#160;&#160;&#160;(0x00000001U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Message type buffer. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga499095c8a6320e4eff3871d739cfafd2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XILMBOX_MSG_TYPE_RESP&#160;&#160;&#160;(0x00000002U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Response type buffer. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf22e2c7d554cc41b64ba743959394334"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIPI_DONE_TIMEOUT_VAL&#160;&#160;&#160;2000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Timeout for IPI. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>.</p>

</div>
</div>
<a class="anchor" id="ga325538ceb2db30df5882c8e45353836a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIPI_IPI_DONE_BIT_SLEEP_IN_US&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sleep for 1Us. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>.</p>

</div>
</div>
<a class="anchor" id="gad14b42daa39e07711ec871f737bdb41b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_INTR_ID&#160;&#160;&#160;22U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Interrupt id. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>.</p>

</div>
</div>
<a class="anchor" id="gadf643d08bd8cbcfde6234a6bdaae9e88"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI0&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(0)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI0 channel. </p>

</div>
</div>
<a class="anchor" id="ga9dfcd88e42de7df2bb14c4e53cb0baf0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI1&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(8)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI1 channel. </p>

</div>
</div>
<a class="anchor" id="gab888e665d43986e50eaba5abcdcda68a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI10&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(27)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI10 channel. </p>

</div>
</div>
<a class="anchor" id="ga27bb5399c2b52ff698f50939e852ef96"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI2&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(9)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI2 channel. </p>

</div>
</div>
<a class="anchor" id="gae693c768701e9ebac21c32682c99a6be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI3&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(16)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI3 channel. </p>

</div>
</div>
<a class="anchor" id="gacc4bcf7cc2a5141b29870f870baf539e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI4&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(17)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI4 channel. </p>

</div>
</div>
<a class="anchor" id="ga18b88012ba5175a2fda995623f674deb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI5&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(18)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI5 channel. </p>

</div>
</div>
<a class="anchor" id="ga15fe91a5f25cb5c519934a3433cda5ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI6&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(19)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI6 channel. </p>

</div>
</div>
<a class="anchor" id="ga44541be2c1254fe744f234ebc7f862de"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI7&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(24)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI7 channel. </p>

</div>
</div>
<a class="anchor" id="gaae8d87074363b612d23bb0fdcd7227c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI8&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(25)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI8 channel. </p>

</div>
</div>
<a class="anchor" id="ga614efa3482faad5c76efb8e9d8bcaba1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_IPI9&#160;&#160;&#160;<a class="el" href="group__xilmailbox.html#gad27cc17b25bb93134368d5eb21126eae">BIT</a>(26)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IPI9 channel. </p>

</div>
</div>
<a class="anchor" id="gaf83db6a62871c736b4f8f485d56caed8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_MAX_CHANNELS&#160;&#160;&#160;11U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum channel. </p>

</div>
</div>
<a class="anchor" id="ga02889c9c255257274405440f2e0398f0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_MAX_MSG_LEN&#160;&#160;&#160;XIPIPSU_MAX_MSG_LEN</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum number of Messages (each 4-bytes long) </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0661fcb809edc8a04919686b2c24c2de"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_1U&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload lengths. </p>
<p>Payload length of size 1byte </p>

</div>
</div>
<a class="anchor" id="ga3ac9914b3773f66786c14b83ed4ec1d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_2U&#160;&#160;&#160;(2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 2byte. </p>

</div>
</div>
<a class="anchor" id="ga433526fce7d55430d5dd884c55236595"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_3U&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 3byte. </p>

</div>
</div>
<a class="anchor" id="ga8bd056c2d1d38cd4f0c766b71276b64b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_4U&#160;&#160;&#160;(4U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 4byte. </p>

</div>
</div>
<a class="anchor" id="gad6fec3e5646c0de92448b1ac51a3d8fb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_5U&#160;&#160;&#160;(5U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 5byte. </p>

</div>
</div>
<a class="anchor" id="ga5e6886e99fe8eed940eb84c67bdf7717"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_6U&#160;&#160;&#160;(6U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 6byte. </p>

</div>
</div>
<a class="anchor" id="ga0f56628c135a38c50e52c4346895ca81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XMAILBOX_PAYLOAD_LEN_7U&#160;&#160;&#160;(7U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload length of size 7byte. </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gade56a2dd883b18d7ae9a891483c90b40"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a>  <a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data structure used to refer XilMailbox. </p>
<p>XilMailbox structure </p>

</div>
</div>
<a class="anchor" id="ga2dd8ee990e164df828207776499cf9bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XMailbox_ErrorHandler)(void *CallBackRefPtr, u32 ErrorMask)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Error handler. </p>

</div>
</div>
<a class="anchor" id="ga8c6dc8e77b4ca1440fff62efadefa502"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XMailbox_RecvHandler)(void *CallBackRefPtr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive handler. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga143f24a7eb4d52ae8289dd2a76104b5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__xilmailbox.html#ga143f24a7eb4d52ae8289dd2a76104b5e">XMailbox_Handler</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef contains XMAILBOX Handler Types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga143f24a7eb4d52ae8289dd2a76104b5ea875addbc928be95ae410ab219c1cfcd3"></a>XMAILBOX_RECV_HANDLER</em>&nbsp;</td><td class="fielddoc">
<p>For Recv Handler. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga143f24a7eb4d52ae8289dd2a76104b5ea4bb156987a17b1507eff3df3e601c716"></a>XMAILBOX_ERROR_HANDLER</em>&nbsp;</td><td class="fielddoc">
<p>For Error Handler. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="gaa7c3c20ddbc2f808a7520d82d1f1778a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__xilmailbox.html#gaa7c3c20ddbc2f808a7520d82d1f1778a">XMailbox_IpiSharedMemState</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef contains XMAILBOX shared memory state. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaa7c3c20ddbc2f808a7520d82d1f1778aac0cb85045fed16a25937a7e3d3db62b6"></a>XMAILBOX_SHARED_MEM_UNINITIALIZED</em>&nbsp;</td><td class="fielddoc">
<p>Shared memory uninitialized. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaa7c3c20ddbc2f808a7520d82d1f1778aaadb64220277cf0ee43d0dbd58d09e895"></a>XMAILBOX_SHARED_MEM_INITIALIZED</em>&nbsp;</td><td class="fielddoc">
<p>Shared memory initialized. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3f7e6c0a58db61bda83ef28be9acba71"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIpiPs_ErrorIntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>XMailboxPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function implements the interrupt handler for errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XMailboxPtr</td><td>Pointer to the XMailbox instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga94ad8c15322f8aa87898da64c12d680c">XMboxTag::ErrorHandler</a>, <a class="el" href="group__xilmailbox.html#ga28ee974b8253aed6cd98a41d017e92b5">XMboxTag::ErrorRefPtr</a>, and <a class="el" href="group__xilmailbox.html#ga90293f74a32c52eb71ecf11d8c34bc3d">IPI_BASEADDRESS</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2cd630709ee77e8c082f923c2a72ec67"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIpiPs_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the ZynqMP Mailbox Instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the IPI Instance to be worked on</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if initialization was successful XST_FAILURE in case of failure </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga5697f39a913b178ec64c6cff4575bb0e">XMailbox_Agent::GicInst</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, and <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4f8f4f223ac7cab8c35b259803256e50"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIpiPs_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>XMailboxPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function implements the interrupt handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XMailboxPtr</td><td>Pointer to the XMailbox instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, <a class="el" href="group__xilmailbox.html#ga19abe88291a590c4043f0c14f3abbea6">XMboxTag::RecvHandler</a>, and <a class="el" href="group__xilmailbox.html#gacd81ebeec1ff8eb6bbd4b62922688353">XMboxTag::RecvRefPtr</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>.</p>

</div>
</div>
<a class="anchor" id="gadb81c93bcb13ef48d004b89eb27ecc6c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIpiPs_PollforDone </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Poll for an acknowledgement using Observation Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS in case of success XST_FAILURE in case of failure </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, <a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a>, <a class="el" href="group__xilmailbox.html#gaf22e2c7d554cc41b64ba743959394334">XIPI_DONE_TIMEOUT_VAL</a>, and <a class="el" href="group__xilmailbox.html#ga325538ceb2db30df5882c8e45353836a">XIPI_IPI_DONE_BIT_SLEEP_IN_US</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send()</a>, and <a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga56a6cdab3dba08f469f27b341aa3c178"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIpiPs_RecvData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>MsgBufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads an IPI message. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">MsgBufferPtr</td><td>is the pointer to Buffer to which the read message needs to be stored </td></tr>
    <tr><td class="paramname">MsgLen</td><td>is the number of messages (each message is 4bytes) </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if unsuccessful </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, and <a class="el" href="group__xilmailbox.html#ga4a6fb8ef4ca25e40d3640a37ae80704c">XMailbox_Agent::SourceId</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0c82843dbbfc6bf3010fa1966de899e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPs_RegisterIrq </td>
          <td>(</td>
          <td class="paramtype">XScuGic *&#160;</td>
          <td class="paramname"><em>IntcInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IpiIntrId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function registers an irq. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IntcInstancePtr</td><td>Pointer to the scugic instance </td></tr>
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">IpiIntrId</td><td>is the interrupt id of the IPI</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if unsuccessful </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, <a class="el" href="group__xilmailbox.html#ga3f7e6c0a58db61bda83ef28be9acba71">XIpiPs_ErrorIntrHandler()</a>, <a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler()</a>, and <a class="el" href="group__xilmailbox.html#gad14b42daa39e07711ec871f737bdb41b">XMAILBOX_INTR_ID</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init()</a>.</p>

</div>
</div>
<a class="anchor" id="gafe03d42ebcf3d3e93c2fb709de6e9142"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIpiPs_Send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Is_Blocking</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function triggers an IPI to a destnation CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance. </td></tr>
    <tr><td class="paramname">Is_Blocking</td><td>if set trigger the notification in blocking mode</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS in case of success XST_FAILURE in case of failure </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, <a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a>, and <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="gae6a5843a165afbc782fb45ab48e8b77d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIpiPs_SendData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>MsgBufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Is_Blocking</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends an IPI message to a destnation CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">MsgBufferPtr</td><td>is the pointer to Buffer which contains the message to be sent </td></tr>
    <tr><td class="paramname">MsgLen</td><td>is the number of messages (each message is 4bytes) </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer </td></tr>
    <tr><td class="paramname">Is_Blocking</td><td>if set trigger the notification in blocking mode</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS in case of success XST_FAILURE in case of failure </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga626145fbf006cb062b91ef47889a49ed">XMailbox_Agent::IpiInst</a>, <a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a>, and <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>.</p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4c4631ec46d933f1fff9ce944c3b82d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_GetSharedMem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u64 **&#160;</td>
          <td class="paramname"><em>Address</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the shared memory location for IPI usage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XMailbox instance. </td></tr>
    <tr><td class="paramname">Address</td><td>Pointer to the address of the variable for which memory needs to be assigned</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Size Size of the memory allocated for IPI usage </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga7807e734780a6c78cf0129b065d8a0b3">XMboxTag::SharedMem</a>, and <a class="el" href="group__xilmailbox.html#ggaa7c3c20ddbc2f808a7520d82d1f1778aaadb64220277cf0ee43d0dbd58d09e895">XMAILBOX_SHARED_MEM_INITIALIZED</a>.</p>

</div>
</div>
<a class="anchor" id="ga212445a83a040999add733502bcc34e9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the XMailbox Instance. </p>
<p>Functions for <a class="el" href="xilmailbox_8c.html">xilmailbox.c</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the IPI Instance to be worked on</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if initialization was successful XST_FAILURE in case of failure </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init()</a>, <a class="el" href="group__xilmailbox.html#ga56a6cdab3dba08f469f27b341aa3c178">XIpiPs_RecvData()</a>, <a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send()</a>, <a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData()</a>, <a class="el" href="group__xilmailbox.html#gacfc620b1b6bee8a53e35bd937d01ef9a">XMboxTag::XMbox_IPI_Recv</a>, <a class="el" href="group__xilmailbox.html#gac988653f4102330b66dffc80008e5947">XMboxTag::XMbox_IPI_Send</a>, and <a class="el" href="group__xilmailbox.html#gad2979174f02c95bba9e1a9a82da86eb6">XMboxTag::XMbox_IPI_SendData</a>.</p>

</div>
</div>
<a class="anchor" id="ga1e5da60f7c2fc80ec54209fc4031c03b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_Recv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SourceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>BufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads an IPI message. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">SourceId</td><td>is the Mask for the CPU which has sent the message </td></tr>
    <tr><td class="paramname">BufferPtr</td><td>is the pointer to Buffer to which the read message needs to be stored </td></tr>
    <tr><td class="paramname">MsgLen</td><td>is the number of messages (each message is 4bytes) </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer (XILMBOX_MSG_TYPE_REQ or XILMBOX_MSG_TYPE_RESP)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if unsuccessful </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga4a6fb8ef4ca25e40d3640a37ae80704c">XMailbox_Agent::SourceId</a>, <a class="el" href="group__xilmailbox.html#gab916c58f41e76689faa0d2ca46df0427">XILMBOX_MSG_TYPE_REQ</a>, <a class="el" href="group__xilmailbox.html#ga499095c8a6320e4eff3871d739cfafd2">XILMBOX_MSG_TYPE_RESP</a>, <a class="el" href="group__xilmailbox.html#ga02889c9c255257274405440f2e0398f0">XMAILBOX_MAX_MSG_LEN</a>, and <a class="el" href="group__xilmailbox.html#gacfc620b1b6bee8a53e35bd937d01ef9a">XMboxTag::XMbox_IPI_Recv</a>.</p>

</div>
</div>
<a class="anchor" id="gae18bdfda3723a66063211be38ad0a541"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XMailbox_ReleaseSharedMem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function releases the shared memory. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS - if memory is released</li>
<li>XST_FAILURE - if memory is not released </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga7807e734780a6c78cf0129b065d8a0b3">XMboxTag::SharedMem</a>, and <a class="el" href="group__xilmailbox.html#ggaa7c3c20ddbc2f808a7520d82d1f1778aac0cb85045fed16a25937a7e3d3db62b6">XMAILBOX_SHARED_MEM_UNINITIALIZED</a>.</p>

</div>
</div>
<a class="anchor" id="ga3b1215935d7ba605846e3a13f015e956"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_Send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>RemoteId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Is_Blocking</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function triggers an IPI to a destination CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">RemoteId</td><td>is the Mask of the CPU to which IPI is to be triggered </td></tr>
    <tr><td class="paramname">Is_Blocking</td><td>if set trigger the notification in blocking mode</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if unsuccessful </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a>, and <a class="el" href="group__xilmailbox.html#gac988653f4102330b66dffc80008e5947">XMboxTag::XMbox_IPI_Send</a>.</p>

</div>
</div>
<a class="anchor" id="ga4c8296024494f03b6e33a54fe80ba3da"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_SendData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>RemoteId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>BufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Is_Blocking</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends an IPI message to a destination CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the XMailbox instance </td></tr>
    <tr><td class="paramname">RemoteId</td><td>is the Mask of the CPU to which IPI is to be triggered </td></tr>
    <tr><td class="paramname">BufferPtr</td><td>is the pointer to Buffer which contains the message to be sent </td></tr>
    <tr><td class="paramname">MsgLen</td><td>is the number of messages (each message is 4bytes) </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer (XILMBOX_MSG_TYPE_REQ (OR) XILMBOX_MSG_TYPE_RESP) </td></tr>
    <tr><td class="paramname">Is_Blocking</td><td>if set trigger the notification in blocking mode</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful</li>
<li>XST_FAILURE if unsuccessful </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga74c5b640e4fca80f8de65a5c516f6674">XMboxTag::Agent</a>, <a class="el" href="group__xilmailbox.html#ga5de32cff7d1fe5e482d0e3d75b528e6f">XMailbox_Agent::RemoteId</a>, <a class="el" href="group__xilmailbox.html#gab916c58f41e76689faa0d2ca46df0427">XILMBOX_MSG_TYPE_REQ</a>, <a class="el" href="group__xilmailbox.html#ga499095c8a6320e4eff3871d739cfafd2">XILMBOX_MSG_TYPE_RESP</a>, <a class="el" href="group__xilmailbox.html#ga02889c9c255257274405440f2e0398f0">XMAILBOX_MAX_MSG_LEN</a>, and <a class="el" href="group__xilmailbox.html#gad2979174f02c95bba9e1a9a82da86eb6">XMboxTag::XMbox_IPI_SendData</a>.</p>

</div>
</div>
<a class="anchor" id="gafbc26a4d8f0d4cff937f88b125defe01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XMailbox_SetCallBack </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#ga143f24a7eb4d52ae8289dd2a76104b5e">XMailbox_Handler</a>&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackFuncPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRefPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This routine installs an asynchronous callback function for the given HandlerType. </p>
<pre>
HandlerType              Callback Function Type
-----------------------  --------------------------------------------------
XMAILBOX_RECV_HANDLER      Recv handler
XMAILBOX_ERROR_HANDLER   Error handler</pre><pre></pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XMailbox instance. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>specifies which callback is to be attached. </td></tr>
    <tr><td class="paramname">CallBackFuncPtr</td><td>is the address of the callback function. </td></tr>
    <tr><td class="paramname">CallBackRefPtr</td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS when handler is installed.</li>
<li>XST_FAILURE when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga94ad8c15322f8aa87898da64c12d680c">XMboxTag::ErrorHandler</a>, <a class="el" href="group__xilmailbox.html#ga28ee974b8253aed6cd98a41d017e92b5">XMboxTag::ErrorRefPtr</a>, <a class="el" href="group__xilmailbox.html#ga19abe88291a590c4043f0c14f3abbea6">XMboxTag::RecvHandler</a>, <a class="el" href="group__xilmailbox.html#gacd81ebeec1ff8eb6bbd4b62922688353">XMboxTag::RecvRefPtr</a>, <a class="el" href="group__xilmailbox.html#gga143f24a7eb4d52ae8289dd2a76104b5ea4bb156987a17b1507eff3df3e601c716">XMAILBOX_ERROR_HANDLER</a>, and <a class="el" href="group__xilmailbox.html#gga143f24a7eb4d52ae8289dd2a76104b5ea875addbc928be95ae410ab219c1cfcd3">XMAILBOX_RECV_HANDLER</a>.</p>

</div>
</div>
<a class="anchor" id="ga5a04406fa4d00d2acad6a32ff7a4230b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_SetSharedMem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__xilmailbox.html#gade56a2dd883b18d7ae9a891483c90b40">XMailbox</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>Address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the shared memory location for IPI usage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XMailbox instance. </td></tr>
    <tr><td class="paramname">Address</td><td>Address of shared memory location </td></tr>
    <tr><td class="paramname">Size</td><td>Size of the memory location</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS - if memory is set for IPI usage</li>
<li>XST_FAILURE - On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilmailbox.html#ga7807e734780a6c78cf0129b065d8a0b3">XMboxTag::SharedMem</a>, and <a class="el" href="group__xilmailbox.html#ggaa7c3c20ddbc2f808a7520d82d1f1778aaadb64220277cf0ee43d0dbd58d09e895">XMAILBOX_SHARED_MEM_INITIALIZED</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ga4a9a0371a0256d6ba537a3db7698fb08"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XMailbox_IpiSharedMem::Address</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address of the shared memory location. </p>

</div>
</div>
<a class="anchor" id="ga74c5b640e4fca80f8de65a5c516f6674"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_mailbox___agent.html">XMailbox_Agent</a> XMboxTag::Agent</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Agent to store IPI channel information. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init()</a>, <a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler()</a>, <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>, <a class="el" href="group__xilmailbox.html#ga56a6cdab3dba08f469f27b341aa3c178">XIpiPs_RecvData()</a>, <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>, <a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send()</a>, <a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData()</a>, <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>, <a class="el" href="group__xilmailbox.html#ga3b1215935d7ba605846e3a13f015e956">XMailbox_Send()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga94ad8c15322f8aa87898da64c12d680c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__xilmailbox.html#ga2dd8ee990e164df828207776499cf9bc">XMailbox_ErrorHandler</a> XMboxTag::ErrorHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback for rx IPI event. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga3f7e6c0a58db61bda83ef28be9acba71">XIpiPs_ErrorIntrHandler()</a>, and <a class="el" href="group__xilmailbox.html#gafbc26a4d8f0d4cff937f88b125defe01">XMailbox_SetCallBack()</a>.</p>

</div>
</div>
<a class="anchor" id="ga28ee974b8253aed6cd98a41d017e92b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XMboxTag::ErrorRefPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>To be passed to the error interrupt callback. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga3f7e6c0a58db61bda83ef28be9acba71">XIpiPs_ErrorIntrHandler()</a>, and <a class="el" href="group__xilmailbox.html#gafbc26a4d8f0d4cff937f88b125defe01">XMailbox_SetCallBack()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5697f39a913b178ec64c6cff4575bb0e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XScuGic XMailbox_Agent::GicInst</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Interrupt instance. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init()</a>.</p>

</div>
</div>
<a class="anchor" id="ga626145fbf006cb062b91ef47889a49ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XIpiPsu XMailbox_Agent::IpiInst</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Ipi instance. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga2cd630709ee77e8c082f923c2a72ec67">XIpiPs_Init()</a>, <a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler()</a>, <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>, <a class="el" href="group__xilmailbox.html#ga56a6cdab3dba08f469f27b341aa3c178">XIpiPs_RecvData()</a>, <a class="el" href="group__xilmailbox.html#ga0c82843dbbfc6bf3010fa1966de899e4">XIpiPs_RegisterIrq()</a>, <a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send()</a>, and <a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga19abe88291a590c4043f0c14f3abbea6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__xilmailbox.html#ga8c6dc8e77b4ca1440fff62efadefa502">XMailbox_RecvHandler</a> XMboxTag::RecvHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive handler. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler()</a>, and <a class="el" href="group__xilmailbox.html#gafbc26a4d8f0d4cff937f88b125defe01">XMailbox_SetCallBack()</a>.</p>

</div>
</div>
<a class="anchor" id="gacd81ebeec1ff8eb6bbd4b62922688353"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XMboxTag::RecvRefPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>To be passed to the receive interrupt callback. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga4f8f4f223ac7cab8c35b259803256e50">XIpiPs_IntrHandler()</a>, and <a class="el" href="group__xilmailbox.html#gafbc26a4d8f0d4cff937f88b125defe01">XMailbox_SetCallBack()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5de32cff7d1fe5e482d0e3d75b528e6f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_Agent::RemoteId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remote id. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#gadb81c93bcb13ef48d004b89eb27ecc6c">XIpiPs_PollforDone()</a>, <a class="el" href="group__xilmailbox.html#gafe03d42ebcf3d3e93c2fb709de6e9142">XIpiPs_Send()</a>, <a class="el" href="group__xilmailbox.html#gae6a5843a165afbc782fb45ab48e8b77d">XIpiPs_SendData()</a>, <a class="el" href="group__xilmailbox.html#ga3b1215935d7ba605846e3a13f015e956">XMailbox_Send()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7807e734780a6c78cf0129b065d8a0b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMailbox_IpiSharedMem XMboxTag::SharedMem</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>shared memory segment </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga4c4631ec46d933f1fff9ce944c3b82d6">XMailbox_GetSharedMem()</a>, <a class="el" href="group__xilmailbox.html#gae18bdfda3723a66063211be38ad0a541">XMailbox_ReleaseSharedMem()</a>, and <a class="el" href="group__xilmailbox.html#ga5a04406fa4d00d2acad6a32ff7a4230b">XMailbox_SetSharedMem()</a>.</p>

</div>
</div>
<a class="anchor" id="ga73b6a118babef017d2679b59a0410a89"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__xilmailbox.html#gaa7c3c20ddbc2f808a7520d82d1f1778a">XMailbox_IpiSharedMemState</a> XMailbox_IpiSharedMem::SharedMemState</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>State of shared memory. </p>

</div>
</div>
<a class="anchor" id="gae27eb1bb697a00c85f295ef36cd55632"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_IpiSharedMem::Size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size of the shared memory location. </p>

</div>
</div>
<a class="anchor" id="ga4a6fb8ef4ca25e40d3640a37ae80704c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XMailbox_Agent::SourceId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source id. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga56a6cdab3dba08f469f27b341aa3c178">XIpiPs_RecvData()</a>, and <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>.</p>

</div>
</div>
<a class="anchor" id="gacfc620b1b6bee8a53e35bd937d01ef9a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32(* XMboxTag::XMbox_IPI_Recv)(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads an IPI message. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>, and <a class="el" href="group__xilmailbox.html#ga1e5da60f7c2fc80ec54209fc4031c03b">XMailbox_Recv()</a>.</p>

</div>
</div>
<a class="anchor" id="gac988653f4102330b66dffc80008e5947"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32(* XMboxTag::XMbox_IPI_Send)(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, u8 Is_Blocking)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Triggers an IPI to a destination CPU. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>, and <a class="el" href="group__xilmailbox.html#ga3b1215935d7ba605846e3a13f015e956">XMailbox_Send()</a>.</p>

</div>
</div>
<a class="anchor" id="gad2979174f02c95bba9e1a9a82da86eb6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32(* XMboxTag::XMbox_IPI_SendData)(struct <a class="el" href="struct_x_mbox_tag.html">XMboxTag</a> *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IPI message to a destination CPU. </p>

<p>Referenced by <a class="el" href="group__xilmailbox.html#ga212445a83a040999add733502bcc34e9">XMailbox_Initialize()</a>, and <a class="el" href="group__xilmailbox.html#ga4c8296024494f03b6e33a54fe80ba3da">XMailbox_SendData()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
